Added new params for textInference by Sirsho1997 · Pull Request #287 · Runware/sdk-python

Sirsho1997 · 2026-05-04T09:06:37Z

Added

Added text inference cache support:
- TextInferenceCacheScope = Literal["system", "system+history"]
- TextInferenceCacheTtl = Literal["5m", "1h"]
- ITextInferenceCache dataclass (scope, ttl) with request key cache
ITextInputs now includes:
- documents: Optional[List[Union[str, File]]]
ITextInferenceTool now supports:
- schema: Optional[Dict[str, Any]]
- backward-compatible input_schema alias (serialized as schema when schema is not provided)
- optional toolType (serialized as type)
Added ITextInferenceToolChoice request serialization support:
- request_key = "toolChoice"
- toolType -> type mapping in serialize()

Changed

toolChoice moved from ISettings to the root ITextInference payload:
- ITextInference.toolChoice: Optional[Union[ITextInferenceToolChoice, Dict[str, Any]]]
- _buildTextRequest() now includes root-level toolChoice
Unified text-input media preprocessing in runware/base.py via _processTextInputs() and applied it to both _requestText() and _requestTextStream(), so images/videos/documents are normalized consistently for sync/async/stream text requests.

coderabbitai · 2026-05-04T09:06:44Z

Important

Review skipped

Auto reviews are disabled on this repository. To trigger a review, include review in the PR description. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 71acc7df-3138-432d-a67b-199c55345de4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

✨ Simplify code

Create PR with simplified code
Commit simplified code in branch feature-updateLLMSettings

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Copilot

Pull request overview

This PR extends the text-inference request surface in the SDK by adding new request parameters and preprocessing for an additional input type. It fits into the existing runware.types request-model layer and the runware.base request-building/sending flow for text inference.

Changes:

Added new text-inference settings/types for cache control and document inputs.
Updated ITextInferenceTool to accept new schema/type-related fields and custom serialization.
Added document preprocessing in the non-stream text request path.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
`runware/types.py`	Adds new text-inference request models/fields (`cache`, `documents`) and changes tool initialization/serialization behavior.
`runware/base.py`	Processes `inputs.documents` before building non-stream text inference requests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…sTextInputs()

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

runware/utils.py:56

Environment.PRODUCTION WebSocket base URL was changed to wss://ws-api.runware.dev/v1, which looks like a non-production endpoint and also no longer matches the documented production endpoint (wss://ws-api.runware.ai/v1) or the production HTTP base URL (https://api.runware.ai/v1). This will cause default SDK connections (and HTTP streaming URL mapping via _WS_TO_HTTP) to target the wrong host.

BASE_RUNWARE_URLS = {
    Environment.PRODUCTION: "wss://ws-api.runware.dev/v1",
    Environment.TEST: "ws://localhost:8080",
}

# HTTP REST base URL for streaming (e.g. textInference with deliveryMethod=stream)
BASE_RUNWARE_HTTP_URLS = {
    Environment.PRODUCTION: "https://api.runware.ai/v1",
    Environment.TEST: "http://localhost:8080",
}

# Map each WebSocket base URL to its HTTP counterpart (for streaming requests).
_WS_TO_HTTP = {
    BASE_RUNWARE_URLS[Environment.PRODUCTION]: BASE_RUNWARE_HTTP_URLS[Environment.PRODUCTION],
    BASE_RUNWARE_URLS[Environment.TEST]: BASE_RUNWARE_HTTP_URLS[Environment.TEST],
}

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

runware/utils.py:49

Environment.PRODUCTION WebSocket base URL was changed to wss://ws-api.runware.dev/v1, while the production HTTP base URL remains https://api.runware.ai/v1. This likely breaks production connectivity (and creates an inconsistent WS↔HTTP mapping in _WS_TO_HTTP). If this isn't intentional, revert to the .ai endpoint; if it is intentional, the HTTP base URL and docs/config should be updated consistently.

BASE_RUNWARE_URLS = {
    Environment.PRODUCTION: "wss://ws-api.runware.dev/v1",
    Environment.TEST: "ws://localhost:8080",
}

# HTTP REST base URL for streaming (e.g. textInference with deliveryMethod=stream)
BASE_RUNWARE_HTTP_URLS = {
    Environment.PRODUCTION: "https://api.runware.ai/v1",
    Environment.TEST: "http://localhost:8080",

teith

fix url and lgtm

teith · 2026-05-07T19:16:42Z


 BASE_RUNWARE_URLS = {
-    Environment.PRODUCTION: "wss://ws-api.runware.ai/v1",
+    Environment.PRODUCTION: "wss://ws-api.runware.dev/v1",


Added supoport for new params

cfd22fb

Sirsho1997 requested a review from Copilot May 4, 2026 09:07

Copilot started reviewing on behalf of Sirsho1997 May 4, 2026 09:08 View session

Copilot AI reviewed May 4, 2026

View reviewed changes

Comment thread runware/types.py

Comment thread runware/base.py Outdated

Comment thread runware/types.py Outdated

Comment thread runware/types.py Outdated

Sirsho1997 changed the title ~~Added supoport for new params~~ Added new params for textInference May 4, 2026

Sirsho1997 added 2 commits May 5, 2026 19:36

Fixed types.py

7e1168c

Unified text-input media preprocessing in runware/base.py via _proces…

26c9bd7

…sTextInputs()

Sirsho1997 requested a review from Copilot May 5, 2026 14:20

Copilot started reviewing on behalf of Sirsho1997 May 5, 2026 14:21 View session

Copilot AI reviewed May 5, 2026

View reviewed changes

Comment thread runware/base.py

Comment thread runware/types.py Outdated

Comment thread runware/types.py

Comment thread runware/types.py Outdated

Sirsho1997 added 4 commits May 6, 2026 11:39

Fixed toolChoice

abaa0a4

Discarded changelog temp

e652eb7

Fixed backward compatibility

7bcf4af

Fixed backward compatibility for ISettings.toolChoice

7ac52b4

Sirsho1997 requested a review from Copilot May 7, 2026 03:38

Copilot started reviewing on behalf of Sirsho1997 May 7, 2026 03:39 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread runware/types.py

Comment thread runware/types.py

Comment thread runware/base.py

Comment thread runware/types.py

Fixed backward comp for type and toolType

3ffbc0a

Sirsho1997 requested a review from Copilot May 7, 2026 06:58

Copilot started reviewing on behalf of Sirsho1997 May 7, 2026 06:58 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread runware/types.py

Comment thread runware/types.py

Comment thread runware/base.py

Comment thread runware/types.py

Added backward compat for toolChoice as InitVar

b61615a

teith approved these changes May 7, 2026

View reviewed changes

Conversation

Sirsho1997 commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Added

Changed

Uh oh!

coderabbitai Bot commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

teith left a comment

Choose a reason for hiding this comment

Uh oh!

teith May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Sirsho1997 commented May 4, 2026 •

edited

Loading

coderabbitai Bot commented May 4, 2026 •

edited

Loading